--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
lang/README.zh.md 2db12e0bde7ecc92688a8cc2e37ff71bab4d290f (2db12e0b) Text, 9.91 KB
Tc9d1d9# Reticulum MeshChatX
[Tff7b72English README](Te6edf3../README.md) | [Tff7b72Deutsch](Te6edf3README.de.md) | [Tff7b72Italiano](Te6edf3README.it.md) | [Tff7b72Русский](Te6edf3README.ru.md) | [Tff7b72日本語](Te6edf3README.ja.md)
Liam Cottle 开发的 Reticulum MeshChat 的一个功能丰富的深度修改分支。
本项目独立于原始 Reticulum MeshChat 项目，与其无关联。
Tff7b72- 网站: [Tff7b72meshchatx.com](Te6edf3https://meshchatx.com)
Tff7b72- 源码: [Tff7b72git.quad4.io/RNS-Things/MeshChatX](Te6edf3https://git.quad4.io/RNS-Things/MeshChatX)
Tff7b72- 官方镜像: [Tff7b72github.com/Sudo-Ivan/MeshChatX](Te6edf3https://github.com/Sudo-Ivan/MeshChatX) — 目前亦用于 Windows 与 macOS 构建。
Tff7b72- 发行版: [Tff7b72git.quad4.io/RNS-Things/MeshChatX/releases](Te6edf3https://git.quad4.io/RNS-Things/MeshChatX/releases)
Tff7b72- 变更日志: [Ta5d6ff`CHANGELOG.md`](../CHANGELOG.md)
Tff7b72- TODO: [Tff7b72Boards](Te6edf3https://git.quad4.io/RNS-Things/MeshChatX/projects)
Tc9d1d9## 与 Reticulum MeshChat 的重要差异
Tff7b72- 使用 LXST
Tff7b72- 以原生 SQL 替代 Peewee ORM
Tff7b72- 以原生 Ta5d6ff`fetch` 替代 Axios
Tff7b72- 使用最新 Electron
Tff7b72- Ta5d6ff`.whl` 内置 Web 服务器与前端资源，便于多种部署方式
Tff7b72- i18n
Tff7b72- 使用 PNPM 与 Poetry 管理依赖
Tff7b72> [!WARNING]
Tff7b72> MeshChatX 不保证与旧版 Reticulum MeshChat 的数据兼容。迁移或测试前请备份数据。
Tff7b72> [!WARNING]
Tff7b72> 旧系统尚未完全支持。当前最低要求：Python `>=3.11`，Node `>=24`。
Tc9d1d9## 系统要求
Tff7b72- Python Ta5d6ff`>=3.11`（来自 Ta5d6ff`pyproject.toml`）
Tff7b72- Node.js Ta5d6ff`>=24`（来自 Ta5d6ff`package.json`）
Tff7b72- pnpm Ta5d6ff`10.32.1`（来自 Ta5d6ff`package.json`）
Tff7b72- Poetry（用于 Ta5d6ff`Taskfile.yml` 与 CI 工作流）
Ta5d6ff```Ta5d6ffbash
task install
task lint:all
task test:all
task build:all
Ta5d6ff```
Tc9d1d9## 安装方式
请按运行环境与打包形式选择。
| 方式 | 包含前端 | 架构 | 适用场景 |
| --------------------- | -------- | ---------------------------- | ----------------------------------- |
| Docker 镜像 | 是 | Ta5d6ff`linux/amd64`, Ta5d6ff`linux/arm64` | Linux 服务器快速部署 |
| Python wheel (Ta5d6ff`.whl`) | 是 | 任何 Python 支持的架构 | 无需 Node 构建的无头/Web 服务器安装 |
| Linux AppImage | 是 | Ta5d6ff`x64`, Ta5d6ff`arm64` | 便携式桌面使用 |
| Debian 包 (Ta5d6ff`.deb`) | 是 | Ta5d6ff`x64`, Ta5d6ff`arm64` | Debian/Ubuntu 安装 |
| RPM 包 (Ta5d6ff`.rpm`) | 是 | 取决于 CI | Fedora/RHEL/openSUSE |
| 从源码 | 本地构建 | 主机架构 | 开发与自定义构建 |
说明:
Tff7b72- 发布工作流明确构建 Linux Ta5d6ff`x64` 与 Ta5d6ff`arm64` 的 AppImage + DEB。
Tff7b72- RPM 亦会尝试构建，成功时上传。
Tc9d1d9## 快速开始: Docker
Ta5d6ff```Ta5d6ffbash
docker compose up -d
Ta5d6ff```
默认 compose 文件映射:
Tff7b72- 主机 Ta5d6ff`127.0.0.1:8000` -> 容器端口 Ta5d6ff`8000`
Tff7b72- Ta5d6ff`./meshchat-config` -> Ta5d6ff`/config` 持久化
如遇权限问题:
Ta5d6ff```Ta5d6ffbash
sudo chown -R T79c0ff1000:1000 ./meshchat-config
Ta5d6ff```
Tc9d1d9## 从发行版安装
Tc9d1d9### 1) Linux AppImage (x64/arm64)
Tff7b721. 从发行版下载 Ta5d6ff`ReticulumMeshChatX-v<版本>-linux-<架构>.AppImage`。
Tff7b722. 赋予执行权限并运行:
Ta5d6ff```Ta5d6ffbash
chmod +x ./ReticulumMeshChatX-v*-linux-*.AppImage
./ReticulumMeshChatX-v*-linux-*.AppImage
Ta5d6ff```
Tc9d1d9### 2) Debian/Ubuntu `.deb` (x64/arm64)
Tff7b721. 下载 Ta5d6ff`ReticulumMeshChatX-v<版本>-linux-<架构>.deb`。
Tff7b722. 安装:
Ta5d6ff```Ta5d6ffbash
sudo apt install ./ReticulumMeshChatX-v*-linux-*.deb
Ta5d6ff```
Tc9d1d9### 3) RPM 系统
Tff7b721. 若发行版中存在，下载 Ta5d6ff`ReticulumMeshChatX-v<版本>-linux-<架构>.rpm`。
Tff7b722. 安装:
Ta5d6ff```Ta5d6ffbash
sudo rpm -Uvh ./ReticulumMeshChatX-v*-linux-*.rpm
Ta5d6ff```
Tc9d1d9### 4) Python wheel (`.whl`)
发行版 wheel 包含已构建的前端资源。
Ta5d6ff```Ta5d6ffbash
pip install ./reticulum_meshchatx-*-py3-none-any.whl
meshchatx --headless
Ta5d6ff```
亦支持 Ta5d6ff`pipx`:
Ta5d6ff```Ta5d6ffbash
pipx install ./reticulum_meshchatx-*-py3-none-any.whl
Ta5d6ff```
Tc9d1d9## 从源码运行（Web 服务器模式）
在开发或需要本地定制构建时使用。
Ta5d6ff```Ta5d6ffbash
git clone https://git.quad4.io/RNS-Things/MeshChatX.git
Tffa657cd MeshChatX
corepack Tffa657enable
pnpm install
pip install poetry
poetry install
pnpm run build-frontend
poetry run python -m meshchatx.meshchat --headless --host T79c0ff127.0.0.1
Ta5d6ff```
Tc9d1d9## 在沙盒中运行（Linux）
若要在额外隔离文件系统的情况下运行原生 Ta5d6ff`meshchatx`（别名：`meshchat`），可使用 **Firejail** 或 **Bubblewrap**（Ta5d6ff`bwrap`），同时保留 Reticulum 与 Web 界面所需的网络访问。完整示例（pip/pipx、Poetry、USB 串口说明）见:
Tff7b72- [Ta5d6ff`docs/meshchatx_linux_sandbox.md`](../docs/meshchatx_linux_sandbox.md)
在提供已捆绑或已同步的 Ta5d6ff`meshchatx-docs` 时，应用内 **文档**（MeshChatX 文档）列表亦会显示同一页面。
Tc9d1d9## 从源码构建桌面包
脚本定义于 Ta5d6ff`package.json` 与 Ta5d6ff`Taskfile.yml`。
Tc9d1d9### Linux x64 AppImage + DEB
Ta5d6ff```Ta5d6ffbash
pnpm run dist:linux-x64
Ta5d6ff```
Tc9d1d9### Linux arm64 AppImage + DEB
Ta5d6ff```Ta5d6ffbash
pnpm run dist:linux-arm64
Ta5d6ff```
Tc9d1d9### RPM
Ta5d6ff```Ta5d6ffbash
pnpm run dist:rpm
Ta5d6ff```
或通过 Task:
Ta5d6ff```Ta5d6ffbash
task dist:fe:rpm
Ta5d6ff```
Tc9d1d9## 架构支持
Tff7b72- Docker: Ta5d6ff`amd64`, Ta5d6ff`arm64`
Tff7b72- Linux AppImage: Ta5d6ff`x64`, Ta5d6ff`arm64`
Tff7b72- Linux DEB: Ta5d6ff`x64`, Ta5d6ff`arm64`
Tff7b72- Windows: Ta5d6ff`x64`, Ta5d6ff`arm64`（提供构建脚本）
Tff7b72- macOS: 提供构建脚本（`arm64`、`universal`），适用于本地构建环境
Tff7b72- Android: 仓库内含项目与 CI 工作流
Tc9d1d9## Android
Tff7b72- [Ta5d6ff`docs/meshchatx_on_android_with_termux.md`](../docs/meshchatx_on_android_with_termux.md)
Tff7b72- [Ta5d6ff`android/README.md`](../android/README.md)
Tc9d1d9## 配置
| 参数 | 环境变量 | 默认值 | 说明 |
| -------------------------- | ---------------------------------------- | ----------- | ----------------------------------------------------------------------------------------------- |
| Ta5d6ff`--host` | Ta5d6ff`MESHCHAT_HOST` | Ta5d6ff`127.0.0.1` | Web 服务器绑定地址 |
| Ta5d6ff`--port` | Ta5d6ff`MESHCHAT_PORT` | Ta5d6ff`8000` | Web 服务器端口 |
| Ta5d6ff`--no-https` | Ta5d6ff`MESHCHAT_NO_HTTPS` | Ta5d6ff`false` | 禁用 HTTPS |
| Ta5d6ff`--ssl-cert` / Ta5d6ff`--ssl-key` | Ta5d6ff`MESHCHAT_SSL_CERT` / Ta5d6ff`MESHCHAT_SSL_KEY` | （无） | PEM 证书与私钥路径；需同时设置。覆盖身份下 Ta5d6ff`ssl/` 目录中自动生成的证书。 |
| Ta5d6ff`--rns-log-level` | Ta5d6ff`MESHCHAT_RNS_LOG_LEVEL` | （无） | Reticulum（RNS）日志级别：`none`、`critical`、`error` 等或数值。同时设置时 CLI 优先于环境变量。 |
| Ta5d6ff`--headless` | Ta5d6ff`MESHCHAT_HEADLESS` | Ta5d6ff`false` | 不自动打开浏览器 |
| Ta5d6ff`--auth` | Ta5d6ff`MESHCHAT_AUTH` | Ta5d6ff`false` | 启用基本认证 |
| Ta5d6ff`--storage-dir` | Ta5d6ff`MESHCHAT_STORAGE_DIR` | Ta5d6ff`./storage` | 数据目录 |
| Ta5d6ff`--public-dir` | Ta5d6ff`MESHCHAT_PUBLIC_DIR` | 自动/捆绑 | 前端文件目录（无捆绑资源安装时需要） |
Tc9d1d9## 分支
| 分支 | 用途 |
| -------- | ---------------------------------------- |
| Ta5d6ff`master` | 稳定发布。仅限生产就绪代码。 |
| Ta5d6ff`dev` | 活跃开发。可能包含不稳定或不完整的更改。 |
Tc9d1d9## 开发
Ta5d6ff`Taskfile.yml` 中的常用任务:
Ta5d6ff```Ta5d6ffbash
task install
task lint:all
task test:all
task build:all
Ta5d6ff```
Ta5d6ff`Makefile` 快捷方式:
| 命令 | 说明 |
| -------------- | --------------------------- |
| Ta5d6ff`make install` | 安装 pnpm 与 poetry 依赖 |
| Ta5d6ff`make run` | 通过 poetry 运行 MeshChatX |
| Ta5d6ff`make build` | 构建前端 |
| Ta5d6ff`make lint` | 运行 eslint 与 ruff |
| Ta5d6ff`make test` | 运行前端与后端测试 |
| Ta5d6ff`make clean` | 移除构建产物与 node_modules |
Tc9d1d9## 版本
本仓库当前版本: Ta5d6ff`4.5.0`。
Tff7b72- JavaScript/Electron 版本以 Ta5d6ff`package.json` 为准。
Tff7b72- Ta5d6ff`meshchatx/src/version.py` 通过以下命令与 Ta5d6ff`package.json` 同步:
Ta5d6ff```Ta5d6ffbash
pnpm run version:sync
Ta5d6ff```
发布时请保持相关字段一致（`package.json`、`pyproject.toml`、`meshchatx/__init__.py`）。
Tc9d1d9## 安全
Tff7b72- [Ta5d6ff`SECURITY.md`](../SECURITY.md)
Tff7b72- 应用内置完整性检查与默认 HTTPS/WSS
Tff7b72- Ta5d6ff`.gitea/workflows/` 中的 CI 扫描工作流
Tc9d1d9## 添加语言
语言由目录自动发现。添加新语言只需一个 JSON 文件:
Tff7b721. 从 Ta5d6ff`en.json` 生成空白模板:
Ta5d6ff```Ta5d6ffbash
python scripts/generate_locale_template.py
Ta5d6ff```
将写入 Ta5d6ff`locales.json`，所有键值为空字符串。
Tff7b722. 重命名并移入语言目录:
Ta5d6ff```Ta5d6ffbash
mv locales.json meshchatx/src/frontend/locales/xx.json
Ta5d6ff```
Tff7b723. 在文件顶部设置 Ta5d6ff`_languageName` 为该语言的母语名称（例如 Ta5d6ff`"Espanol"`、Ta5d6ff`"Francais"`）。将显示在语言选择器中。
Tff7b724. 翻译其余全部值。
Tff7b725. 校验键一致性: Ta5d6ff`pnpm test -- tests/frontend/i18n.test.js --run`
无需其他代码更改。应用、语言选择与测试在构建时从 Ta5d6ff`meshchatx/src/frontend/locales/` 发现语言文件。
Tc9d1d9## 致谢
Tff7b72- [Tff7b72Liam Cottle](Te6edf3https://github.com/liamcottle) - 原始 Reticulum MeshChat
Tff7b72- [Tff7b72RFnexus](Te6edf3https://github.com/RFnexus) - Micron 解析器（JavaScript）
Tff7b72- [Tff7b72markqvist](Te6edf3https://github.com/markqvist) - Reticulum, LXMF, LXST
──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────